Skip to content

docs: explain cabal update repository index state - #12448

Merged
mergify[bot] merged 2 commits into
haskell:masterfrom
KeuqS:docs/cabal-update-repository-state
Oct 17, 2026
Merged

docs: explain cabal update repository index state#12448
mergify[bot] merged 2 commits into
haskell:masterfrom
KeuqS:docs/cabal-update-repository-state

Conversation

@KeuqS

@KeuqS KeuqS commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document the REPO[,INDEX-STATE] argument accepted by cabal update.
  • Explain Unix timestamp, ISO 8601 UTC timestamp, and HEAD forms.
  • Clarify that the supplied index state selects the global package index revision and is distinct from a project-local index-state.

Verification

  • Compared the user guide with doc/cmd-v2-help/update.txt to keep the syntax and examples aligned.
  • Documentation-only change; no runtime code or tests are affected.

Checklist

  • This PR does not modify behaviour or interface.
  • The documentation has been updated.

Fixes #12447

@KeuqS

KeuqS commented Oct 12, 2026

Copy link
Copy Markdown
Contributor Author

Updated the branch with current master in commit cd0052e so the PR is no longer out of date. The documentation change remains a single-file, 13-line addition and git diff --check passes; the newly triggered documentation checks are now running.

Mikolaj
Mikolaj approved these changes Oct 14, 2026
View reviewed changes

@Mikolaj Mikolaj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

ffaf1
ffaf1 approved these changes Oct 14, 2026
View reviewed changes

@ffaf1 ffaf1 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks.

@zlonast zlonast added merge me Tell Mergify Bot to merge squash+merge me Tell Mergify Bot to squash-merge and removed merge me Tell Mergify Bot to merge labels Oct 15, 2026
@mergify mergify Bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days queued labels Oct 15, 2026
@mergify

mergify Bot commented Oct 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Merge Queue Status

  • ✅ Entered queue — 2026-10-17 04:27 UTC · Rule: squash-merge · triggered by rule Put pull requests in the squash+merge queue
  • ✅ Checks passed · on draft merge queue: checking #12448 on master (aeac769) #12470
  • ✅ Merged — 2026-10-17 06:30 UTC · at f7ad3aa5ca69aa93cf2aae857bbde00d71ed38d6 · squash

This pull request spent 2 hours 3 minutes 2 seconds in the queue, including 1 hour 51 minutes 40 seconds running CI.

Required conditions to merge
  • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
  • github-review-approved [🛡 GitHub branch protection]
  • any of [🛡 GitHub branch protection]:
    • check-success = Doctest Cabal
    • check-neutral = Doctest Cabal
    • check-skipped = Doctest Cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Meta checks
    • check-neutral = Meta checks
    • check-skipped = Meta checks
  • any of [🛡 GitHub branch protection]:
    • check-success = docs/readthedocs.org:cabal
    • check-neutral = docs/readthedocs.org:cabal
    • check-skipped = docs/readthedocs.org:cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Validate post job
    • check-neutral = Validate post job
    • check-skipped = Validate post job
  • any of [🛡 GitHub branch protection]:
    • check-success = fourmolu
    • check-neutral = fourmolu
    • check-skipped = fourmolu
  • any of [🛡 GitHub branch protection]:
    • check-success = hlint
    • check-neutral = hlint
    • check-skipped = hlint
  • any of [🛡 GitHub branch protection]:
    • check-success = Bootstrap post job
    • check-neutral = Bootstrap post job
    • check-skipped = Bootstrap post job
  • any of [🛡 GitHub branch protection]:
    • check-success = whitespace
    • check-neutral = whitespace
    • check-skipped = whitespace
  • any of [🛡 GitHub branch protection]:
    • check-success = Check sdist post job
    • check-neutral = Check sdist post job
    • check-skipped = Check sdist post job
  • any of [🛡 GitHub branch protection]:
    • check-success = Changelogs
    • check-neutral = Changelogs
    • check-skipped = Changelogs

@mergify mergify Bot mentioned this pull request Oct 17, 2026
Closed
44 of 84 tasks
@mergify
mergify Bot merged commit f7ad3aa into haskell:master Oct 17, 2026
73 of 79 checks passed
@mergify mergify Bot removed the queued label Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mikolaj Mikolaj Mikolaj approved these changes
@ffaf1 ffaf1 ffaf1 approved these changes

Assignees

No one assigned

Labels

merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days ready and waiting Mergify is waiting out the cooldown period squash+merge me Tell Mergify Bot to squash-merge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

cabal update underdocumented

4 participants

@KeuqS @Mikolaj @ffaf1 @zlonast